Security News
Combatting Alert Fatigue by Prioritizing Malicious Intent
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
remark-lint-code-block-style
Advanced tools
remark-lint rule to warn when code blocks do not adhere to a given style
Warn when code blocks do not adhere to a given style.
Options: 'consistent'
, 'fenced'
, or 'indented'
, default: 'consistent'
.
'consistent'
detects the first used code block style and warns when
subsequent code blocks uses different styles.
remark-stringify
formats code blocks using a fence if they have a language flag and
indentation if not.
Pass
fences: true
to always use fences for code blocks.
See Using remark to fix your Markdown on how to automatically fix warnings for this rule.
This rule is included in the following presets:
Preset | Setting |
---|---|
remark-preset-lint-consistent | 'consistent' |
remark-preset-lint-markdown-style-guide | 'fenced' |
ok.md
When configured with 'indented'
.
alpha();
Paragraph.
bravo();
No messages.
not-ok.md
When configured with 'indented'
.
```
alpha();
```
Paragraph.
```
bravo();
```
1:1-3:4: Code blocks should be indented
7:1-9:4: Code blocks should be indented
ok.md
When configured with 'fenced'
.
```
alpha();
```
Paragraph.
```
bravo();
```
No messages.
not-ok-fenced.md
When configured with 'fenced'
.
alpha();
Paragraph.
bravo();
1:1-1:13: Code blocks should be fenced
5:1-5:13: Code blocks should be fenced
not-ok-consistent.md
alpha();
Paragraph.
```
bravo();
```
5:1-7:4: Code blocks should be indented
not-ok-incorrect.md
When configured with '💩'
.
1:1: Incorrect code block style `💩`: use either `'consistent'`, `'fenced'`, or `'indented'`
npm:
npm install remark-lint-code-block-style
You probably want to use it on the CLI through a config file:
…
"remarkConfig": {
"plugins": [
…
"lint",
+ "lint-code-block-style",
…
]
}
…
Or use it on the CLI directly
remark -u lint -u lint-code-block-style readme.md
Or use this on the API:
var remark = require('remark')
var report = require('vfile-reporter')
remark()
.use(require('remark-lint'))
+ .use(require('remark-lint-code-block-style'))
.process('_Emphasis_ and **importance**', function (err, file) {
console.error(report(err || file))
})
See contributing.md
in remarkjs/.github
for ways
to get started.
See support.md
for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
FAQs
remark-lint rule to warn when code blocks do not adhere to a given style
The npm package remark-lint-code-block-style receives a total of 87,672 weekly downloads. As such, remark-lint-code-block-style popularity was classified as popular.
We found that remark-lint-code-block-style demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.